home *** CD-ROM | disk | FTP | other *** search
/ Mac Mania 4 / MacMania 4.toast / / Tools&Utilities / MTX Tool 1.3 / guide / format.txt < prev    next >
Text File  |  1996-04-27  |  7KB  |  180 lines
  1. Summary of Simple Marked Text (MTX) Format
  2. Version 1.3.2 - 4/27/96 by Richard Rathe
  3.  
  4. General Considerations
  5.  
  6.   Source file names have an .mtx extension.
  7.   HTML file names have an .html extension.
  8.   Files contain only ASCII characters
  9.     (return, linefeed, tab, space to ~).
  10.   Paragraphs are delimited by blank lines. Extra blank
  11.     lines will be eliminated. Adjacent lines will be
  12.     combined into a single paragraph.
  13.   Lines indented with spaces or tabs will become an item
  14.     in a list.
  15.   Items marked by a "N" use Netscape HTML extensions. For
  16.     maximum compatibility, avoid these tags.
  17.   The %HOME, %PARENT, %PREV, %NEXT and table tags have
  18.     changed since version 1.2. You may need to update
  19.     older MTX files to be compatible.
  20.  
  21. Special Tags
  22.  
  23.   %TITLE title       - title for HTML page
  24.  N%TITLE $title      - title with centered heading 
  25.   %HEADING none      - supress heading
  26.   %HEADING heading   - heading different from title
  27.  N%HEADING $heading  - centered heading
  28.   %FILE name         - name for HTML file
  29.   %IMAGES path       - path for image files
  30.   %LOGO name         - title inline graphic (.gif)
  31.  N%LOGO $name        - centered title graphic (.gif)
  32.   %ICON name         - heading inline graphic (.gif)
  33.  N%WATERMARK name    - watermark graphic (.gif)
  34.  N%COLORS colors     - background and text colors
  35.   %HOME text         - label for home document
  36.   %HOMEURL url       - URL for home document
  37.   %HOMEURL none      - no URL for home document
  38.   %PARENT text       - label for parent document
  39.   %PARENTURL url     - URL for parent document
  40.   %PARENTURL none    - no URL for parent document
  41.   %INDEX text        - label for index document
  42.   %INDEXURL url      - URL for index document
  43.   %INDEXURL none     - no URL for index document
  44.   %PREV text         - label for previous document
  45.   %PREVURL url       - URL for previous document
  46.   %PREVURL none      - no URL for previous document
  47.   %NEXT text         - label for next document
  48.   %NEXTURL url       - URL for next document
  49.   %NEXTURL none      - no URL for next document
  50.   %BASE path         - path for relative URLs
  51.   %PATH path         - path for document only
  52.   %AUTHOR text       - author or copyright info
  53.   %AUTHURL url       - URL for author or copyright
  54.   %VERSION text      - document version info
  55.   %VERSURL url       - URL for document version
  56.   %OUTLINE none      - no outline
  57.   %OUTLINE long      - long outline
  58.   %LAYOUT cover      - suppress administrative info
  59.   %LAYOUT print      - suppress navigation info
  60.   %LAYOUT keyword    - file contains a keyword list
  61.   %LAYOUT noindex    - suppress indexing of this file
  62.   %LAYOUT feedback   - override feedback suppression
  63.   %LAYOUT nofeedback - suppress feedback for all questions
  64.  N%LAYOUT slide      - presentation slide format
  65.  N%REFRESH seconds   - client pull refresh
  66.  N%REFRESH secs url  - client pull refresh with link
  67.   %COUNTER date url  - counter date and cgi url
  68.   %MTX version       - MTX format version
  69.   %any other text    - comment line (ignored)
  70.  
  71.   NOTE: Each document will have a short outline at the top
  72.     unless otherwise specified. Links to email addresses
  73.     will be prefixed with "mailto:" automatically. Default
  74.     "Home," "Parent," "Previous," and "Next" labels will
  75.     be used if not otherwise specified.
  76.  
  77. Heading Tags (must occur at the beginning of line)
  78.  
  79.   #heading text      - primary outline heading
  80.   ##heading text     - secondary outline heading
  81.   ###...             - up to ##### (5) levels deep
  82.  N#$heading text     - centered heading
  83.   #text#url name     - heading link to url outside document
  84.   #text#=anchor name - use heading as named anchor
  85.  
  86.   NOTE: Any text that precedes the first #heading will
  87.     appear just after the title and before the outline.
  88.  
  89. Embedded Tags (can occur anywhere)
  90.  
  91.   {B}            - line break
  92.   {P}            - paragraph break
  93.   {S}            - non-breaking space
  94.   {*text*}       - strong (bold) text
  95.   {!text!}       - emphasized (italics) text
  96.   {@text@}       - fixed font text
  97.   {=name=}       - inline graphic (.gif)
  98.   {=name text=}  - inline graphic with alternate text
  99.   {+name+}       - inline (.gif) with linked (.jpg) graphic
  100.   {+name text+}  - inline graphic with alternate text
  101.   {-name-}       - inline (.gif) with linked (.gif) graphic
  102.   {-name text-}  - inline graphic with alternate text
  103.   {#name#}       - inline (.gif) with linked (.html) file
  104.   {#name text#}  - inline graphic with alternate text
  105.   {#url##}         - link to quoted url
  106.   {#text#url#}     - link to url
  107.   {#text#anchor#}  - link to named anchor
  108.   {#text#=anchor#} - create named anchor
  109.  N{=name alignment=}   - floating graphic (.gif)
  110.  N{+name alignment+}   - floating graphic (.gif+.jpg)
  111.  N{-name alignment-}   - floating graphic (.gif+.gif)
  112.  N{C}            - clear floating graphic alignment
  113.  
  114.   NOTE: File extensions (.gif, .jpg and .html) are
  115.     automatically added to file names. Linked .gif files
  116.     have an "L" added to the name (pictureL.gif). Anchor
  117.     names are case sensitive (#name <> #NAME). Links to
  118.     email addresses will be prefixed with "mailto:"
  119.     automatically. Graphic alignment may be either "left"
  120.     or "right." Floating graphic alignment must be cleared
  121.     using {CLEAR}. Alignment must be before alternate text.
  122.  
  123. List Tags (must occur after leading white space)
  124.  
  125.    text   - bulleted list item
  126.   #text   - numbered list item (1, 2, 3...)
  127.  N@text   - lettered list item (a, b, c...)
  128.  N!text   - roman numbered list item (I, II, III...)
  129.   +text   - glossary list title item (bold)
  130.   -text   - glossary list definition
  131.  
  132.   NOTE: Lists may be nested by using variable amounts
  133.     of leading white space.
  134.  
  135. Format Tags (must occur at the beginning of line)
  136.  
  137.   'text   - block quote
  138.  N''text  - pull quote
  139.   =text   - preformatted text
  140.  N$text   - centered text
  141.   -----   - horizontal rule (one or more dashes)
  142.  
  143. Question Tags (must occur at the beginning of line)
  144.  
  145.   ?x           - begin question (simple feedback)
  146.   ?xyz         - begin question (multiple correct answers)
  147.   ?x?          - begin question (extended feedback)
  148.   ?x?none      - begin question (suppress feedback)
  149.   question text   - question text
  150.   @answer text    - answer text
  151.     feedback text - indented at least one space
  152.  
  153.   NOTE: Questions may have up to 26 (A-Z) answer choices.
  154.     Inline graphics may be used as part of any question,
  155.     answer, or feedback element.
  156.  
  157. Tables (each line must begin with "|") (N)
  158.  
  159. The first line must be one of the following:
  160.   |                     - no caption
  161.   |none                 - no caption
  162.   |caption text         - caption text
  163.   |caption|noborder     - caption for table with no border
  164.   |caption|nowide       - caption for minimal width table
  165.   |caption|noblanks     - caption for table with no blanks
  166.   |caption|nowide|noborder|noblanks  - combination of above
  167. Subsequent lines can be variations of the following:
  168.   |text 1|text 2|text 3 - row with three cells
  169.   |text 1||text 3       - use empty cells where needed
  170.   |text 1|two   |text 3 - cells may be padded with spaces
  171.   |text 1|*     |text 3 - non-blank empty cell use "*"
  172.   |*col 1|*col 2|*col 3 - column headings begin with "*"
  173.   |*row 1|text 1|text 2 - row headings begin with "*"
  174.  
  175.   NOTE: Each line becomes one row in the table. Cells may
  176.   contain graphics or hypertext links. Use {BR} to force
  177.   word wrap within a cell. By default, tables will have
  178.   borders, blanks for empty cells, and resize to cover 95%
  179.   of the window side to side.
  180.